home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / cmsra200.zip / CMS.DOC < prev    next >
Text File  |  1997-05-27  |  42KB  |  1,440 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                            ┌─────┐ ┌───────┐ ┌─────┐
  24.                            │ ┌─┐ │ │ ┌┐ ┌┐ │ │ ┌───┘
  25.                            │ │ └─┘ │ ││ ││ │ │ └───┐
  26.                            │ │ ┌─┐ │ │└─┘│ │ └───┐ │
  27.                            │ └─┘ │ │ │   │ │ ┌───┘ │
  28.                            └─────┘ └─┘   └─┘ └─────┘
  29.  
  30.                          Credit Maintenance System v2.0
  31.  
  32.                                       for
  33.                            
  34.                           RemoteAccess v2.0x and v2.50
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.                                        
  52.  
  53.                  Copyright (C) 1996-97 Remote Link Communications
  54.  
  55.                               All Rights Reserved
  56.  
  57.  
  58.  
  59.  
  60.  
  61.         CMS Manual
  62.         ────────────────────────────────────────────────────────────────
  63.  
  64.  
  65.           ============================================================
  66.                                 Table Of Contents
  67.           ------------------------------------------------------------
  68.  
  69.             1  Introduction........................................1
  70.                1.1 Licence Agreement and disclaimer................2
  71.                1.2 Registration....................................4
  72.                1.3 The key system..................................4
  73.                1.4 Files...........................................5
  74.          
  75.             2  Getting Start.......................................6
  76.                2.1 CMS Version.....................................6
  77.                2.2 System Requirement..............................6
  78.                2.3 DOS Environment.................................6
  79.                2.4 Networking and Multi-tasking Environment........6
  80.                2.5 Installation....................................7
  81.                    2.5.1 Compressed Electronic Distribution........7
  82.                    2.5.2 Floppy Disk Distribution..................7
  83.                2.6 Notes...........................................7
  84.  
  85.             3  CMSCFG.EXE..........................................8
  86.                3.1 System Data.....................................9
  87.                    3.1.1  Registration Details.....................9
  88.                           3.1.1.1  Sysop Name......................9
  89.                           3.1.1.2  System Name.....................9
  90.                           3.1.1.3  Serial No.......................9
  91.                    3.1.2  Miscellaneous............................9
  92.                           3.1.2.1  Auto Update.....................9
  93.                           3.1.2.2  Colour Patten...................9
  94.                           3.1.2.3  Update Comment..................9
  95.                    3.1.3  Directory...............................10
  96.                           3.1.3.1  System.........................10
  97.                           3.1.3.2  Log File.......................10
  98.                           3.1.3.3  Message Base...................10
  99.                           3.1.3.4  Temporary Working..............10
  100.                    3.1.4  Log File - Setting......................10
  101.                3.2 Credit Manager.................................11
  102.                    3.2.1  Examples................................12
  103.                    3.2.2  Edit Mode...............................12
  104.                3.3 Credit Ledger..................................13
  105.                    3.3.1 Active...................................13
  106.                    3.3.2 Report Level.............................13
  107.                    3.3.3 Path & File Name.........................13
  108.                    3.3.4 Examples of Report.......................14
  109.                3.4 Information....................................15
  110.                3.5 Exit Program...................................15
  111.                                                                   
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.         ────────────────────────────────────────────────────────────────
  119.                                      - I -
  120.  
  121.         CMS Manual
  122.         ────────────────────────────────────────────────────────────────
  123.  
  124.  
  125.             4  Mail Template......................................16
  126.                4.1 Creating Mail Template.........................16
  127.                4.2 Example of Mail Template.......................16
  128.                4.3 List of Macros.................................17
  129.  
  130.             5  CMS.EXE............................................18
  131.                5.1 Command Line...................................18
  132.                5.2 Error Level....................................19
  133.                    5.2.1 Extension Code...........................19
  134.                    5.2.2 Error Level - 5..........................19
  135.  
  136.             6  Credits............................................20
  137.                6.1 Beta Team......................................20
  138.                6.2 Visual Interface...............................20
  139.                6.3 Manual Preparation.............................20
  140.  
  141.             7  Program Support....................................21
  142.                7.1 Comments or Suggestions........................21
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.         ────────────────────────────────────────────────────────────────
  179.                                     - II -
  180.  
  181.         CMS Manual
  182.         ────────────────────────────────────────────────────────────────
  183.  
  184.  
  185.           1. Introduction
  186.  
  187.           Credit Maintenance System  (CMS)  is  a software that allows
  188.           you easily maintain users' credit.
  189.  
  190.           CMS  will  perform upgrade function when a user's cumulative 
  191.           credits  reach  the  threshold  of  upgrade.  Then  it  will 
  192.           simultaneously deduct the amount of credit for upgrading and 
  193.           show the residual credits.
  194.  
  195.           CMS also keeps a transaction record for later review.
  196.  
  197.           CMS has an ability to report a formatted text file  in  four
  198.           different levels, from summary to detail.
  199.  
  200.           CMS  can change the users' security level and their flags in
  201.           RemoteAccess database and even update the users' comments.
  202.  
  203.           CMS  can  also  post  a tailor-made email to users informing
  204.           their latest status in upgrading.
  205.  
  206.           Moreover,  CMS  also  has an ability to prepare a summary of
  207.           upgrading.
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.         ────────────────────────────────────────────────────────────────
  239.                                      - 1 -
  240.  
  241.         CMS Manual
  242.         ────────────────────────────────────────────────────────────────
  243.  
  244.  
  245.           1.1    Licence Agreement and Disclaimer       Revision: 0003
  246.  
  247.           "CMS"  refers  to  the  executables and documentation in the
  248.           original distribution archive.
  249.           CMS  is copyright (C) 1996-97 Remote Link Communications. It
  250.           can only be used in  accordance  with the conditions set out
  251.           in this licence agreement.
  252.              
  253.              1. You acknowledge and agree that CMS is a proprietary
  254.                 product  of  the  author,  which  is  protected  by
  255.                 copyright  laws  and  relevant international treaty
  256.                 provisions.
  257.                 You further acknowledge that all rights, title, and
  258.                 interest  in and to  CMS  are and shall remain with
  259.                 the author.
  260.  
  261.              2. You can use CMS for a period of thirty (30) days on 
  262.                 a   trial  basis  in  order  to  determine  it   is
  263.                 suitability  for your particular application. After
  264.                 this  period you MUST register  CMS  or discontinue
  265.                 using it.
  266.  
  267.              3. Registration  entitles  you  to  a non-transferable
  268.                 licence to use  CMS  and any future versions of CMS
  269.                 for  as  long  as you wish,  subject to any special
  270.                 licensing  conditions  and  applicable upgrade fees
  271.                 attached to future versions.
  272.  
  273.              4. In  the  event  that  you  are in violation of this
  274.                 agreement, you agree and accept that the author can
  275.                 cancel your registration and withdraw rights to use 
  276.                 CMS. In case of dispute over the licence agreement,
  277.                 you further agree and accept to fully reimburse the  
  278.                 author  any legal and other expenses resulting from
  279.                 the dispute, should the dispute be decided in favor
  280.                 of the author.
  281.  
  282.              5. CMS, whole or part, must not be included as part of
  283.                 any   software  library  which  is distributed on a
  284.                 commerical  basis  without prior written permission
  285.                 from Eric Tam.
  286.  
  287.              6. CMS is provided  "as is",  without  warranty of any
  288.                 kind  or  fitness for a particular purpose,  either
  289.                 expressed  or  implied,  all  of  which  are hereby
  290.                 explicitly  disclaimed.  The author only guarantees
  291.                 that CMS will occupy disk space.
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.         ────────────────────────────────────────────────────────────────
  299.                                      - 2 -
  300.  
  301.         CMS Manual
  302.         ────────────────────────────────────────────────────────────────
  303.  
  304.  
  305.              7. The author,  Eric Tam,  will  not be held liable to
  306.                 you or anyone for (but not limited to)  any direct,
  307.                 indirect,  incidental   or   consequential  damage,
  308.                 including any loss of profits, loss of saving which 
  309.                 may  result  from  the use or inability to use this
  310.                 program.
  311.  
  312.              8. Eric Tam  is  in  no  obligation  to provide future
  313.                 version of, or support for this software.
  314.  
  315.              9. You may freely distribute unmodified  CMS  provided
  316.                 that no fee is charged.   Pay Bulletin Board System
  317.                 may, however, charge their normal fee provided that
  318.                 no additional charge for CMS is levied.  No part of
  319.                 CMS may be modified,  altered,  reverse engineered,
  320.                 sold,   or distributed in any form whatsoever which
  321.                 would  involve  some  sort  of  trade without prior
  322.                 written permission from the author.
  323.  
  324.             10. Your  use of the program constitutes your agreement
  325.                 to  this  licence agreement and disclaimer and your
  326.                 release  of the author from any form of libility or
  327.                 litigation.
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.                 
  350.            Other brand and product names are trademarks or registered 
  351.                     trademarks of their respective holders.
  352.  
  353.                                         
  354.                  Copyright (C) 1996-97 Remote Link Communications
  355.                                All Rights Reserved.
  356.  
  357.  
  358.         ────────────────────────────────────────────────────────────────
  359.                                      - 3 -
  360.  
  361.         CMS Manual
  362.         ────────────────────────────────────────────────────────────────
  363.  
  364.  
  365.           1.2    Registration
  366.  
  367.           CMS  is  not  a  freeware.  Registration  is  required after
  368.           a  trial  use  of  thirty   (30)   days.  By  doing  so, all 
  369.           "unregistered"  messages  and  almost inaudible beeps within 
  370.           the  program  will  be removed to speed up and to expand the
  371.           performance  of  the  program.  Moreover  you  will  be kept 
  372.           informed of any future development of the software.
  373.  
  374.           If  you  wish to register,  please fill out the registration
  375.           form:   "Register.Doc"
  376.  
  377.           Any   Registration   forms  that  have  invalid  or  missing
  378.           information may be considered void and will not be processed.
  379.           
  380.  
  381.  
  382.           1.3    The key system
  383.  
  384.           Upon  approving your registration, you will receive your own
  385.           key.  Each  key  is  a  small  file  only  1k  in size which
  386.           contains information about your registration. To install the
  387.           key, simply rename it  (if necessary) to KEY.CMS and copy it
  388.           to your CMS system directory.
  389.  
  390.           When   CMS   detects  a  valid key,  it switches itself into
  391.           registered mode and identifies this mode by placing a "+" at
  392.           the end of the version number.
  393.  
  394.           Features marked in this manual with a {+} are only available
  395.           when CMS is running in registered mode. These bonus features
  396.           show our appreciation of your registration.
  397.  
  398.  
  399.           WARNING!
  400.           Your key is unique and under  NO  circumstances should it be
  401.           made  available  to  anyone  else.  Otherwise it is a direct
  402.           violation of the agreement.
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.         ────────────────────────────────────────────────────────────────
  419.                                      - 4 -
  420.  
  421.         CMS Manual
  422.         ────────────────────────────────────────────────────────────────
  423.  
  424.  
  425.           1.4    Files
  426.  
  427.           CMS.EXE  and  CMSCFG.EXE  create  and use a number of files.
  428.           Except  these  two  files,  CMS will create and look for the
  429.           following files in the directory where CMS is located.
  430.           
  431.  
  432.            CONFIG.CMS  General configuration file.
  433.  
  434.            CREDIT.CMS  Contains   all   the  settings  about  Credit
  435.                        Manager.
  436.  
  437.            USERS.CMS   Contains information about transaction record
  438.                        of each user.
  439.  
  440.            KEY.CMS     Your key to activate all registered function.
  441.  
  442.            *.TMP       In  some case, TMP files remain in the System
  443.                        Directory or  TEMP  Directory.  In  most case
  444.                        these  files can  be delete without affecting
  445.                        the performance of the programme.
  446.  
  447.            *.BAK       These  files are backup files. You can delete
  448.                        all  these  files manually to free space.  In
  449.                        most  cases,  these  files will be deleted by
  450.                        the program itself.
  451.  
  452.  
  453.           CMS.EXE  and  CMSCFG.EXE will also look for more files to do
  454.           the setup and update.
  455.  
  456.           These files are:
  457.  
  458.            CONFIG.RA   This file is the configuration about  RA  and
  459.                        should stay in the RA directory.
  460.  
  461.            USERS.BBS   This  file  is  the user's  database file and
  462.                        should  stay  in  the  Message Base directory
  463.                        under RA. (depends on your RA setting)
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.         ────────────────────────────────────────────────────────────────
  479.                                      - 5 -
  480.  
  481.         CMS Manual
  482.         ────────────────────────────────────────────────────────────────
  483.  
  484.  
  485.           2. Getting Start
  486.  
  487.           2.1    CMS Version
  488.  
  489.           CMS  is  using 4d version system, for example v2.0.0.b1, the
  490.           first  digit  is the major version,  the second digit is the
  491.           minor  version,  the  third digit is the patch level and the
  492.           fourth is reserved use for beta version.   You could not see
  493.           the 'b1' because this is reserved for the author beta team.
  494.  
  495.                 The patch level is incremented as minor problems
  496.                 are fixed.
  497.                 The minor version is incremented as new features
  498.                 are added.
  499.                 The major version is incremented as  significant
  500.                 features are added/changed.
  501.  
  502.  
  503.           2.2    System Requirement
  504.  
  505.           To  use  CMS  you  need  an  IBM PC,  386,  486,  Pentium or
  506.           Pentium Pro  or  fully  compatible  computer  with a mono or
  507.           colour video card and a hard disk.
  508.           Also you need MS-DOS or PC-DOS 5.0 or later.  You should set
  509.           at least FILES=30 in their CONFIG.SYS.
  510.  
  511.           In order to run CMS, you need RemoteAccess v2.0x or v2.50.
  512.  
  513.  
  514.           2.3    DOS Environment
  515.  
  516.           This version of  CMS  will not look for it's own environment
  517.           but you should have your RA environment setup.
  518.           Example: SET RA=C:\RA
  519.  
  520.           For  more details about how to set the environment variable,
  521.           refer to your DOS User's Manual.
  522.  
  523.  
  524.           2.4    Networking and Multi-tasking Environment
  525.  
  526.           CMS  version  v2.0.0  and  above  is  'networking and multi-
  527.           tasking aware'.   If you are running from DOS prompt, please
  528.           make sure 'SHARE.COM' is loaded. Failing to do so will cause
  529.           mis-read or mis-write data to files.
  530.  
  531.           For more details about how to load SHARE.COM,  refer to your
  532.           DOS User's Manual.
  533.  
  534.  
  535.  
  536.  
  537.  
  538.         ────────────────────────────────────────────────────────────────
  539.                                      - 6 -
  540.  
  541.         CMS Manual
  542.         ────────────────────────────────────────────────────────────────
  543.  
  544.  
  545.           2.5    Installation
  546.  
  547.           There  are  two different ways to distribute CMS.  They both
  548.           use  the  same  program.  The only difference is the cost of
  549.           distribution.
  550.  
  551.            * Compressed Electronic Distribution
  552.              is distributed electronically.  This mode of distribution
  553.              saves time and costs less.
  554.  
  555.            * Floppy Disk Distribution
  556.              is  distributed through normal floppy disk. It is usually
  557.              shipped with a detailed manual.
  558.  
  559.           Because  of  different  types  of  distribution,  there  are
  560.           different ways to install the package.
  561.  
  562.              *** All registered user will recieve a 'Floppy Disk
  563.                  Distribution'.
  564.  
  565.           2.5.1  Compressed Electronic Distribution
  566.  
  567.           Use DOS command MD to create a directory call CMS. Then copy
  568.           all the decompressed files to this directory.
  569.  
  570.           2.5.2  Floppy Disk Distribution
  571.  
  572.           1. Insert the disk into the disk drive.
  573.           2. Type  A:  then press  ENTER   (this assumes that the disk
  574.              drive is A).
  575.           3. Type  INSTALL   and  press  ENTER.
  576.           4. Follow the instruction on the screen.
  577.  
  578.  
  579.           2.6    Notes
  580.  
  581.           You can only run one of these two CMS programs:  CMS.EXE  or
  582.           CMSCFG.EXE,  at  one  time.  When  you try to start a second
  583.           program,  CMS will display a message indicating that another
  584.           program  is  in  use. If the running program has not stopped
  585.           after 30 seconds, the new entry will abort.
  586.  
  587.           CMS  is using a  FIFO  (First In First Out) thoery. CMS puts
  588.           all  program  in  a  queue waiting for serve. If the running
  589.           program  is  finished  or  quits,  the first computer in the
  590.           queue  will  start  and the rest of the computers will reset
  591.           the waiting timer to zero (0) and rearrange the priority.
  592.  
  593.           In the other word.   Any computer in the queue will wait for
  594.           full 30 seconds.
  595.  
  596.  
  597.  
  598.         ────────────────────────────────────────────────────────────────
  599.                                      - 7 -
  600.  
  601.         CMS Manual
  602.         ────────────────────────────────────────────────────────────────
  603.  
  604.  
  605.           3. CMSCFG.EXE
  606.  
  607.           CMSCFG.EXE is a program that runs in DOS. It is designed for
  608.           CMS to do the configuration.
  609.  
  610.           To run CMSCFG.EXE from the DOS prompt, type
  611.  
  612.                CMSCFG  <ENTER>
  613.  
  614.           The  screen  will  show  the  top-level  CMSCFG  menu  which
  615.           contains five main menu options.
  616.           Each  option  may  have  an  associated  sub  menu. The five
  617.           options and their selections are listed below:
  618.  
  619.  
  620.           System Data
  621.           ────────────────────────────────────────────────────────────
  622.           Your Name; BBS Details; Directory; Log File; etc.
  623.  
  624.  
  625.           Credit Manager
  626.           ────────────────────────────────────────────────────────────
  627.           Add Record; Delete Record; Edit Record.
  628.  
  629.  
  630.           Credit Ledger
  631.           ────────────────────────────────────────────────────────────
  632.           Enable/Disable; Report Level; Path.
  633.  
  634.  
  635.           Information
  636.           ────────────────────────────────────────────────────────────
  637.           Information about CMS.
  638.  
  639.  
  640.           Exit
  641.           ────────────────────────────────────────────────────────────
  642.           Exit CMSCFG and back to operating system.
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.         ────────────────────────────────────────────────────────────────
  659.                                      - 8 -
  660.  
  661.         CMS Manual
  662.         ────────────────────────────────────────────────────────────────
  663.  
  664.  
  665.           3.1    System Data
  666.  
  667.           3.1.1  Registration Details
  668.  
  669.                  3.1.1.1  Sysop Name
  670.                           This  is your name and  MUST  be the same in
  671.                           your registration form.
  672.  
  673.                  3.1.1.2  System Name
  674.                           Your Bulletin Board System (BBS) name.
  675.  
  676.                  3.1.1.3  Serial No.
  677.                           Once  you  register  this program,  you will
  678.                           receive a key file and a serial number.  You
  679.                           just  simply  enter  the serial number here,
  680.                           and  it  would  enable  all  the  registered
  681.                           version function next time you start.
  682.  
  683.  
  684.           3.1.2  Miscellaneous
  685.  
  686.                  3.1.2.1  Auto Update   {+}
  687.                           If you enable Auto Update, it will automati-
  688.                           cally update your configuration base on RA's
  689.                           setting.
  690.  
  691.                  3.1.2.2  Colour Patten
  692.                           CMS / CMSCFG  can display upto six different
  693.                           similative colour patten. They are:
  694.                           1. Novell
  695.                           2. FrontDoor
  696.                           3. FMail
  697.                           4. Turbo Vision
  698.                           5. Norton
  699.                           6. Monochrome
  700.  
  701.                  3.1.2.3  Update Comment   {+}
  702.                           If you enable this function, CMS will update
  703.                           the  user's  comment  that  is located in RA
  704.                           user database.  The user's comment line will
  705.                           tell you 'when' the user is upgraded by CMS.
  706.                           ** CMS  will  not  overwrite  your  existing
  707.                              comment  line.  It will append to the end
  708.                              of  the existing comment line if there is
  709.                              enough space.
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.         ────────────────────────────────────────────────────────────────
  719.                                      - 9 -
  720.  
  721.         CMS Manual
  722.         ────────────────────────────────────────────────────────────────
  723.  
  724.  
  725.           3.1.3  Directory
  726.  
  727.                  3.1.3.1  System
  728.                           The full path where you put CMS.
  729.                           e.g. C:\CMS
  730.  
  731.                  3.1.3.2  Log File
  732.                           Where you want the log file will be locate.
  733.                           e.g. C:\LOGS
  734.  
  735.                  3.1.3.3  Message File
  736.                           If you have a correct environment for RA, it
  737.                           would  automatically  come  up.   The  major
  738.                           function for this directory is to update the
  739.                           USERS.BBS   and   post  messages  to  Hudson
  740.                           Message Base.
  741.  
  742.                  3.1.3.4  Temporary Working
  743.                           This  field  specifies  the  directory where
  744.                           temporary files will store.
  745.  
  746.  
  747.           3.1.4  Log File - Setting
  748.  
  749.                  CMS  will  put all the logging events into a log file
  750.                  called 'CMS.LOG'.  You can find this file in your Log
  751.                  File Directory where you define it.
  752.  
  753.                  Setting
  754.                  To enable or disable logging system event to a file.
  755.  
  756.         
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.         ────────────────────────────────────────────────────────────────
  779.                                      - 10 -
  780.  
  781.         CMS Manual
  782.         ────────────────────────────────────────────────────────────────
  783.  
  784.  
  785.           3.2    Credit Manager
  786.  
  787.           In  this  option,  you  can  see  a list of information that
  788.           includes the following:
  789.  
  790.               Curr Sec.  The Current Security level of user.
  791.  
  792.                New Sec.  The new security level of user.
  793.  
  794.               New Group  The new group of users.
  795.  
  796.             Credit Need  The amount needed to upgrade.
  797.  
  798.           Deduct Amount  The  amount  of  credit deducted from your
  799.                          user.
  800.  
  801.            Mail to User  'Yes' or 'No', If Yes, you need to specify
  802.                          the file name for mail template.
  803.  
  804.           Template File  For sending message to user.
  805.                          (More info. see Section 4 - Mail Template)
  806.  
  807.                    Type  Specifying  the type of message base.  You
  808.                          can select from 'Hudson' or 'JAM'.
  809.  
  810.            Path or Area  If Hudson, it will ask for the area number.
  811.                          ** Area number must be between 1 to 200. **
  812.  
  813.                          If JAM,  it  will ask for the full path and
  814.                          file name.
  815.                          ** File name must NOT have an extension **
  816.  
  817.            Notify Sysop  If Yes,  when a user is upgraded, you will
  818.                          receive a short note about who is upgraded.
  819.  
  820.                   Flags  When  a  user is upgraded,  CMS can change
  821.                          the user's  flags  at the same time. There
  822.                          are  three  possible setting 'X' or '-' or
  823.                          'U'.  If 'U' flag is using,  it means this
  824.                          flag is unchanged.
  825.  
  826.                  Status  The current status for this record. If the
  827.                          record  is marked as 'Delete'.  It will be
  828.                          automatically  deleted  when  you  back to
  829.                          Main Menu.
  830.  
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.         ────────────────────────────────────────────────────────────────
  839.                                      - 11 -
  840.  
  841.         CMS Manual
  842.         ────────────────────────────────────────────────────────────────
  843.  
  844.           3.2.1  Examples
  845.  
  846.           Here is an example:
  847.              Curr Sec.   10       A Flag  UUUUUUUU      Status  Active
  848.               New Sec.   20       B Flag  --------
  849.              New Group   20       C Flag  XXXXXXXX
  850.                 Credit   1002     D Flag  UUUUUUUU
  851.             Deduct Amt   1000
  852.  
  853.           Mail to User   Yes      Template TEMPLATE.TXT
  854.                   Type   Hudson
  855.           Path or Area   3
  856.  
  857.           Notify Sysop   Yes
  858.                   Type   Hudson
  859.           Path or Area   3
  860.  
  861.  
  862.           eg1)  A user is on level 10 and has 1002 credits.
  863.  
  864.                 After  running  CMS.EXE, this user will be upgraded to
  865.                 level  20,  Group  20  and  has 2 credit left. He also
  866.                 will recieve a message in area 3 using a mail template
  867.                 call 'TEMPLATE.TXT'. All 'A Flags' and 'D Flags'  will
  868.                 still stay as before, but all 'B Flags' will change to
  869.                 '-', and all 'C Flags' will change to 'X'.
  870.                 You (Sysop) also will recieve a message regarding this
  871.                 user's upgrade.
  872.  
  873.           eg2)  A user is level 10 and has 999 credits.
  874.  
  875.                 After  run CMS.EXE, this user will still remain on the
  876.                 same level with nothing change.
  877.  
  878.  
  879.  
  880.           3.2.2  Edit Mode
  881.                  'Edit Mode'  allow  you  to change the current record
  882.                  setting.
  883.  
  884.                  <ESC>      Exit Credit Manager and back to Main Menu
  885.                  
  886.                  <Enter>    Edit the current record.
  887.  
  888.                  <INSert>   Insert a new record by pressed 'INS'.
  889.  
  890.                  <DELete>   Mark the current record to delete.
  891.  
  892.  
  893.                  <Arrow>    Up or left arrow change to previous record.
  894.                             Down or right arrow change to next record.    
  895.  
  896.  
  897.  
  898.         ────────────────────────────────────────────────────────────────
  899.                                      - 12 -
  900.  
  901.         CMS Manual
  902.         ────────────────────────────────────────────────────────────────
  903.  
  904.  
  905.           3.3    Credit Ledger    {+}
  906.  
  907.           This  is  one  of the best features in CMS.  CMS will record
  908.           all the transactions in a data file.
  909.           When  you  enable  this  feature,  it  will generate all the
  910.           transactions  in a formatted text like a Summary Sheet in an
  911.           'Accounting System'.
  912.  
  913.           Credit  Ledger  can generate four different levels of report
  914.           from summary to detail.
  915.  
  916.  
  917.           3.3.1  Active
  918.                  You can enable (Yes) or disable (No) this function.
  919.  
  920.           3.3.2  Report Level
  921.                  There  are  four  different types of report you can
  922.                  choose. From summary (level 1) to detail (level 4).
  923.                  See next page for examples.
  924.  
  925.           3.3.3  Path and file name
  926.                  Enter the full path and file name of Credit Ledger.
  927.                  eg.   C:\CMS\REPORT.LOG
  928.  
  929.  
  930.  
  931.  
  932.  
  933.  
  934.  
  935.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957.  
  958.         ────────────────────────────────────────────────────────────────
  959.                                      - 13 -
  960.  
  961.         CMS Manual
  962.         ────────────────────────────────────────────────────────────────
  963.  
  964.  
  965.           3.3.4  Examples of Report.
  966.  
  967.           Level 1 - Summary
  968.  
  969.           1 user(s) upgraded from 10 to 20
  970.  
  971.           1 user(s) upgraded from 20 to 21
  972.  
  973.           Total Credit Collected : 3000
  974.  
  975.  
  976.           Level 2
  977.  
  978.           Name:  Eric Tam                         Last Security 20
  979.           Name:  Ben Lyons                        Last Security 10
  980.           -------------------------------------------------------------
  981.           Total Credit Collected : 3000
  982.  
  983.  
  984.           Level 3
  985.  
  986.           Name:  Eric Tam
  987.           Last Security Level : 20
  988.           Last Group          : 20
  989.  
  990.           Name:  Ben Lyons
  991.           Last Security Level : 10
  992.           Last Group          : 10
  993.  
  994.           -----------------------------------------
  995.            Total Credit Collected :   3000
  996.  
  997.  
  998.            Level 4 - Detail
  999.  
  1000.            Name: Eric Tam
  1001.            Last Date upgraded: 15-06-96
  1002.            Last Sec  Last Group  Last Credit  CurrSec  CurrGroup  Credit Left
  1003.               20        20          2000         21       21          0
  1004.            -------------------------------------------------------------------
  1005.            Name: Ben Lyons
  1006.            Last Date upgraded: 15-06-96
  1007.            Last Sec  Last Group  Last Credit  CurrSec  CurrGroup  Credit Left
  1008.               10        10          1000         20       20          2
  1009.            -------------------------------------------------------------------
  1010.  
  1011.             Total Credit Collected :   3000
  1012.  
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.         ────────────────────────────────────────────────────────────────
  1019.                                      - 14 -
  1020.  
  1021.         CMS Manual
  1022.         ────────────────────────────────────────────────────────────────
  1023.  
  1024.  
  1025.           3.4    Information
  1026.                  This option will display the CMS version number,  and
  1027.                  program copyright notice.
  1028.  
  1029.           3.5    Exit Program
  1030.                  This  option will end program execution and return to
  1031.                  DOS. Pressing <ESCAPE> from the main option menu does
  1032.                  the same thing.  If any changes have been made to the
  1033.                  configuration,   you will prompt "Save changes (Y,n)"
  1034.                  before program exits.  Pressing <ENTER> or  "Y"  will
  1035.                  save  all  changes.  Pressing  "N"  will  discard all
  1036.                  changes. The program then exits to DOS.
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.         ────────────────────────────────────────────────────────────────
  1079.                                      - 15 -
  1080.  
  1081.         CMS Manual
  1082.         ────────────────────────────────────────────────────────────────
  1083.  
  1084.  
  1085.           4. Mail Template
  1086.  
  1087.           Mail  Template  is a message with some macros. It allows you
  1088.           to type a default message and sub in some macros for posting
  1089.           to user.
  1090.  
  1091.  
  1092.           4.1    Creating Mail Template
  1093.  
  1094.           *  Mail Template  MUST  be the same directory where  CMS  is
  1095.              located.
  1096.           *  Mail Template is a normal text file. You can create it by
  1097.              using any text file editor.
  1098.           *  All macros MUST put between '%'.
  1099.           *  All macros are not case sensitive.
  1100.  
  1101.  
  1102.           4.2    Example of Mail Template
  1103.  
  1104.  
  1105.           e.g - Mail Template
  1106.  
  1107.           Hi %USER_FIRST%,
  1108.  
  1109.               Thanks for all your uploads. Now you are upgraded
  1110.               from level %last_sec% to level %new_sec%.
  1111.  
  1112.           %SySoP_Full%
  1113.           %System_Name%
  1114.  
  1115.  
  1116.           e.g - User Andrew will get a message like this.
  1117.  
  1118.           Hi Andrew,
  1119.  
  1120.               Thanks for all your uploads. Now you are upgraded
  1121.               from level 10 to level 20.
  1122.  
  1123.           Eric Tam
  1124.           Remote Link Communications
  1125.  
  1126.  
  1127.  
  1128.  
  1129.  
  1130.  
  1131.  
  1132.  
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.         ────────────────────────────────────────────────────────────────
  1139.                                      - 16 -
  1140.  
  1141.         CMS Manual
  1142.         ────────────────────────────────────────────────────────────────
  1143.  
  1144.  
  1145.             4.3    List of Macros
  1146.  
  1147.             Marcos               Meaning and Example
  1148.             ──────               ───────────────────
  1149.  
  1150.           %PROGRAM_LONG%      Program name 'Credit Maintenance System'
  1151.           %PROGRAM_SHORT%     Program name 'CMS'
  1152.           %VERSION%           Program Version 'v2.0.0'
  1153.  
  1154.           %SYSOP_FULL%        Sysop full name 'Eric Tam'
  1155.           %SYSOP_FIRST%       Sysop first name 'Eric'
  1156.           %SYSOP_LAST%        Sysop last name 'Tam'
  1157.           %SYSTEM_NAME%       System Name 'Remote Link Communications'
  1158.  
  1159.           %USER_FULL%         User full name 'David James Prince'
  1160.           %USER_FIRST%        User first name 'David'
  1161.           %USER_LAST%         User last name 'Prince'
  1162.  
  1163.           %TIME%              Current Time '13:20:05'
  1164.           %DATE%              Today's Date '03-12-96'
  1165.           %DAY%               Day   '03'
  1166.           %MONTH%             Month '12'
  1167.           %MONTH_LONG%        Month 'December'
  1168.           %MONTH_SHORT%       Month 'Dec'
  1169.           %YEAR%              Year  '1996'
  1170.           %SHORT_YEAR%        Year  '96'
  1171.           %DAY_OF_WEEK%       'Sunday'..'Saturday'
  1172.           %S_DAY_OF_WEEK%     'Sun'..'Sat'
  1173.           %GREETING_TIME%     'morning', 'afternoon' or 'evening'
  1174.           %HOUR%              Hour in 12 format  '01'..'12'
  1175.           %HOUR24%            Hour in 24 format  '00'..'23'
  1176.           %MINUTE%            Minute  '00'..'59'
  1177.           %SECOND%            Second  '00'..'59'
  1178.           %AM_PM%             'am' or 'pm'
  1179.  
  1180.           %LAST_SEC%          Security level before upgrade
  1181.           %LAST_GROUP%        Group before upgrade
  1182.           %LAST_CREDIT%       Credit balance before upgrade
  1183.           %NEW_SEC%           Security level after upgrade
  1184.           %NEW_GROUP%         Group after upgrade
  1185.           %DEDUCT_AMT%        Deduct amount
  1186.           %CREDIT_LEFT%       Credit left after upgrade
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.         ────────────────────────────────────────────────────────────────
  1199.                                      - 17 -
  1200.  
  1201.         CMS Manual
  1202.         ────────────────────────────────────────────────────────────────
  1203.  
  1204.  
  1205.           5. CMS.EXE
  1206.  
  1207.           This is the heart of the program.  When you run it,  it will
  1208.           display  a dialog box and a progress bar which indicates the
  1209.           percentage done.
  1210.           
  1211.           To run CMS.EXE from the DOS prompt, type
  1212.  
  1213.                CMS  <ENTER>
  1214.  
  1215.           It   should   run  without  problem.  After  a  few  seconds
  1216.           (depending on the number of users)  you  can  see details of 
  1217.           upgrade.
  1218.  
  1219.             Tip: You can setup CMS run in a night system maintenance
  1220.                  in your batch file.
  1221.  
  1222.  
  1223.           5.1    Command Line     {+}
  1224.  
  1225.           CMS allows additional parameters at the command line.
  1226.           Parameter MUST start with '/' or '-'. 
  1227.  
  1228.              /Dx        This will generate 'x' days Credit Ledger from
  1229.                         today.  eg. If you put /D10,  it will count 10
  1230.                         days  from  today.  So  you  will  get all the
  1231.                         transactions within these 10 days.
  1232.  
  1233.              /Px        This  will  purge  'x'  days  of  transactions
  1234.                         record.  eg. If  you  put /P60,  it will purge
  1235.                         all the transactions record over 60 days.
  1236.  
  1237.                         '/Px' will not allow the 'x' days parameter to
  1238.                         be  less  than  30.  This  is a built-in safty
  1239.                         precaution  against  wiping  out  your  entire
  1240.                         transactions record.
  1241.                         
  1242.              /Rx        Reboot the computer when CMS finishes running.
  1243.                         /RW  Warm boot the computer.
  1244.                         /RC  Cold boot the computer.
  1245.                         
  1246.              /?         Online Help.
  1247.  
  1248.  
  1249.  
  1250.  
  1251.  
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257.  
  1258.         ────────────────────────────────────────────────────────────────
  1259.                                      - 18 -
  1260.  
  1261.         CMS Manual
  1262.         ────────────────────────────────────────────────────────────────
  1263.  
  1264.  
  1265.           5.2    Error Level
  1266.  
  1267.           CMS  will  generate  error  levels if error occurs. They are
  1268.           self explanatory. 
  1269.           
  1270.  
  1271.           Error Level
  1272.  
  1273.              0          Running without problem occur
  1274.  
  1275.              1          Problem with CONFIG.CMS
  1276.  
  1277.              2          Problem with USERS.CMS
  1278.  
  1279.              3          Problem with CREDIT.CMS
  1280.  
  1281.              4          Problem with USERS.BBS
  1282.  
  1283.              5          Another program is running
  1284.  
  1285.              6          Invalid command line
  1286.  
  1287.              7          Error creating Credit Ledger file
  1288.  
  1289.              8          Problem with log file
  1290.  
  1291.              9          Problem with overlay file
  1292.  
  1293.              10         Incorrect DOS version
  1294.  
  1295.  
  1296.  
  1297.           5.2.1    Extension Code
  1298.  
  1299.           All error levels will have an extension.
  1300.           eg. Error Code: 4001.
  1301.  
  1302.           The extension is for the use of the author.
  1303.  
  1304.  
  1305.  
  1306.           5.2.2    Error Level - 5
  1307.  
  1308.           If   you   continuously  get  error level 5,   and  you  are
  1309.           absolutely  sure  that only one program is running,  you can
  1310.           delete 'CMSBUSY.TMP' and 'CMSQUEUE.TMP' if they exist.
  1311.  
  1312.           These files are located in your TEMP directory.
  1313.  
  1314.  
  1315.  
  1316.  
  1317.  
  1318.         ────────────────────────────────────────────────────────────────
  1319.                                      - 19 -
  1320.  
  1321.         CMS Manual
  1322.         ────────────────────────────────────────────────────────────────
  1323.  
  1324.  
  1325.           6. Credits
  1326.  
  1327.           I  would  like  to  specially  thank  my  beta  team and the
  1328.           following persons for their help.
  1329.  
  1330.  
  1331.  
  1332.           6.1    Beta Team
  1333.  
  1334.            Sysop Name             System Name                FidoNet
  1335.           ------------------------------------------------------------
  1336.            Andrew Doherty         Bulldoza Emporium         3:711/458
  1337.  
  1338.  
  1339.  
  1340.           6.2    Visual Interface
  1341.  
  1342.           FrontDoor    - Original visual interface concept designed by
  1343.                          Joaquim Homrighausen. Used with permission.
  1344.  
  1345.           FMail        - Used with permission from Folkert Wijnstra.
  1346.  
  1347.  
  1348.           6.3    Manual Preparation
  1349.  
  1350.           Martin  and  Wendy  who  have assisted in the preparation of
  1351.           this manual.
  1352.  
  1353.  
  1354.  
  1355.  
  1356.  
  1357.  
  1358.  
  1359.  
  1360.  
  1361.  
  1362.  
  1363.  
  1364.  
  1365.  
  1366.  
  1367.  
  1368.  
  1369.  
  1370.  
  1371.  
  1372.  
  1373.  
  1374.  
  1375.  
  1376.  
  1377.  
  1378.         ────────────────────────────────────────────────────────────────
  1379.                                      - 20 -
  1380.  
  1381.         CMS Manual
  1382.         ────────────────────────────────────────────────────────────────
  1383.  
  1384.  
  1385.           7. Program Support
  1386.  
  1387.           The  latest version of CMS can be FREQ from my BBS under the
  1388.           magic name of 'CMS'. (without quote)
  1389.  
  1390.  
  1391.           Remote Link Communications (Dept. of BBS)
  1392.           Eric Tam
  1393.           +61-2-9541-0870
  1394.           FidoNet  3:712/330
  1395.           Yo!Net   8:1010/7
  1396.           Max. Baud: 33600
  1397.  
  1398.           
  1399.           7.1    Comments or Suggestions
  1400.  
  1401.           Please  send  comments  or  suggestions by netmail, or snail
  1402.           mail to me.
  1403.              
  1404.              Netmail
  1405.              To        Eric Tam
  1406.              FidoNet   3:712/330    or
  1407.              SIGnet    28:2500/330
  1408.  
  1409.              Snail Mail
  1410.              Remote Link Communications
  1411.              (Attn.  Eric Tam)
  1412.              P.O. BOX 73
  1413.              MENAI CENTRAL  NSW  2234
  1414.              AUSTRALIA
  1415.  
  1416.  
  1417.  
  1418.  
  1419.  
  1420.  
  1421.  
  1422.  
  1423.  
  1424.  
  1425.  
  1426.  
  1427.  
  1428.  
  1429.  
  1430.  
  1431.  
  1432.  
  1433.  
  1434.  
  1435.  
  1436.  
  1437.  
  1438.         ────────────────────────────────────────────────────────────────
  1439.                                   - 21 - END -
  1440.